[KYUUBI #1269] Online documentation section in the readme is outdated #1270
+14
−19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ulysses-you
force-pushed
the
kyuubi#1269
branch
from
3f29471 to
4b15c2c
Compare
pan3793
reviewed
Oct 21, 2021
README.md
Outdated
| - [v1.0.2](https://kyuubi.readthedocs.io/en/v1.0.2/) | ||
| - [v1.0.1](https://kyuubi.readthedocs.io/en/v1.0.1/) | ||
| - [v1.0.0](https://kyuubi.readthedocs.io/en/v1.0.0/) | ||
| - [master/latest](https://kyuubi.apache.org/docs/latest/) |
There was a problem hiding this comment.
It's not correct, the https://kyuubi.apache.org/docs/latest/ point to the latest released doc. cc @turboFei for double confirm
pan3793
reviewed
Oct 21, 2021
README.md
Outdated
| @@ -96,19 +96,15 @@ The figure below shows our vision for the Kyuubi Ecosystem. Some of them have be | |||
| Since Kyuubi 1.0.0, the Kyuubi online documentation is hosted by [https://readthedocs.org/](https://readthedocs.org/). | |||
|
It seems we need to update the following links as well. [pr-1270] >grep readthedocs * -R
README.md:[](https://kyuubi.apache.org/?badge=latest)
README.md:Since Kyuubi 1.0.0, the Kyuubi online documentation is hosted by [https://readthedocs.org/](https://readthedocs.org/).
README.md:- Improve Documentation - [](https://kyuubi.readthedocs.io/en/latest/?badge=latest)
conf/kyuubi-defaults.conf.template:# Details in https://kyuubi.readthedocs.io/en/latest/deployment/settings.html
docs/deployment/settings.md:# Details in https://kyuubi.readthedocs.io/en/latest/deployment/settings.html
Binary file docs/_build/doctrees/deployment/settings.doctree matches
Binary file docs/_build/doctrees/community/contributions.doctree matches
Binary file docs/_build/doctrees/quick_start/quick_start_with_datagrip.doctree matches
docs/community/contributions.md: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
docs/community/contributions.md:- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request
docs/quick_start/quick_start_with_helm.md:[Using Hive Beeline](https://kyuubi.readthedocs.io/en/latest/quick_start/quick_start.html#using-hive-beeline) to opening a connection.
docs/quick_start/quick_start_with_datagrip.md:[Get kyuubi server started](https://kyuubi.readthedocs.io/en/latest/quick_start/quick_start.html) before you try DataGrip with kyuubi. |
Codecov Report
@@ Coverage Diff @@
## master #1270 +/- ##
============================================
- Coverage 78.30% 78.24% -0.07%
Complexity 110 110
============================================
Files 176 177 +1
Lines 6886 6940 +54
Branches 843 852 +9
============================================
+ Hits 5392 5430 +38
- Misses 1037 1042 +5
- Partials 457 468 +11
Continue to review full report at Codecov.
|
|
thank you @pan3793 @cfmcgrady for the review, addressed comment. |
aajisaka
reviewed
Oct 22, 2021
|
thank you all for the reivew ! merging to master/branch-1.3 |
ulysses-you
added a commit
that referenced
this pull request
Oct 22, 2021
<!-- Thanks for sending a pull request! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html 2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'. 3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'. --> <!-- Please clarify why the changes are needed. For instance, 1. If you add a feature, you can talk about the use case of it. 2. If you fix a bug, you can clarify why it is a bug. --> Closes #1269 docs only Closes #1270 from ulysses-you/kyuubi#1269. Closes #1269 1cb99ef [ulysses-you] address comment 7a597e6 [ulysses-you] address comment 4b15c2c [ulysses-you] Online documentation section in the readme is outdated Authored-by: ulysses-you <[email protected]> Signed-off-by: ulysses-you <[email protected]> (cherry picked from commit 936a532) Signed-off-by: ulysses-you <[email protected]>
yaooqinn
reviewed
Oct 22, 2021
| @@ -79,6 +79,6 @@ Please clarify why the changes are needed. For instance, | |||
|
|
|||
| - [ ] Add screenshots for manual tests if appropriate | |||
|
|
|||
| - [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request | |||
| - [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request | |||
There was a problem hiding this comment.
this PR template is also outdated
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are the changes needed?
Closes #1269
How was this patch tested?
docs only